/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.translation;

/**
 * This enum defined a translatable property. The value of this enum is used for
 * mapping this translation with the object property name. The capitol Enum
 * string is used as a key when storing translation in Jsonb format.
 *
 * @author Morten Olav Hansen <mortenoh@gmail.com>
 */
public enum TranslationProperty
{
    NAME( "name" ),
    SHORT_NAME( "shortName" ),
    DESCRIPTION( "description" ),
    FORM_NAME( "formName" ),
    NUMERATOR_DESCRIPTION( "numeratorDescription" ),
    DENOMINATOR_DESCRIPTION( "denominatorDescription" ),
    RELATIONSHIP_FROM_TO_NAME( "fromToName" ),
    RELATIONSHIP_TO_FROM_NAME( "toFromName" ),
    INSTRUCTION( "instruction" ),
    INCIDENT_DATE_LABEL( "incidentDateLabel" ),
    ENROLLMENT_DATE_LABEL( "enrollmentDateLabel" ),
    EXECUTION_DATE_LABEL( "executionDateLabel" ),
    DUE_DATE_LABEL( "dueDateLabel" ),
    CONTENT( "content" );

    private String name;

    TranslationProperty( String name )
    {
        this.name = name;
    }

    public static TranslationProperty fromValue( String value )
    {
        for ( TranslationProperty type : TranslationProperty.values() )
        {
            if ( type.getName().equalsIgnoreCase( value ) )
            {
                return type;
            }
        }

        return null;
    }

    public String getName()
    {
        return name;
    }
}
